home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / C++ / Applications / NeuroSim 1.0 / Documentation / Read Me (NeuroSim) < prev   
Text File  |  1996-02-20  |  9KB  |  207 lines
  1. _______________________________________________________________
  2. NeuroSim — A freeware Mac application
  3. Version 1.0 (February 1996)
  4.  
  5. By Timo Eloranta
  6. Copyright © 1996 Brown Eyes Software
  7. All rights reserved.
  8.  
  9. Internet e-mail:  sttiel@uta.fi        
  10. WWW home page:  http://www.uta.fi/~sttiel/
  11. _______________________________________________________________
  12.  
  13. Contents
  14.  
  15.   •  Description
  16.   •  System Requirements
  17.   •  How to "Play"...
  18.   •  Known Weaknesses
  19.   •  Version History
  20.   •  Credits & Acknowledgments
  21.   •  Distribution
  22.   •  Fine Print
  23.   •  Need a Mac Developer?
  24.   •  Contacting the Author
  25.  
  26.  
  27. Description
  28.  
  29. NeuroSim is a simple neural net simulator. A neural net is formed
  30. by a matrix of connected neurons. Every neuron has a state which is
  31. described with an integer. Every neuron also has a border value, which
  32. equals the number of connections starting from the neuron. When the
  33. state of the neuron exceeds the neuron's border value, the neuron lights
  34. up and sends an impulse to all the neurons it's connected to. The impulse
  35. increases the state of every connected neuron by one. After lighting up
  36. the neuron's state returns to zero.
  37.  
  38. NeuroSim allows the user to create new neural nets with specified
  39. characteristics and to "play" with the nets by manually lighting up
  40. certain neurons (known as receptors). There's also a demo mode...
  41.  
  42.   
  43. System Requirements
  44.  
  45.   •  a Mac equipped with a 68020 or greater CPU
  46.   •  MacOS 7.0 or later
  47.   •  about 500 K of free RAM
  48.   •  a color monitor
  49.   •  ObjectSupportLib (only PowerMacs need this)
  50.  
  51.   •  Note: NeuroSim is a "fat binary" and runs entirely in native PowerPC
  52.       code if you have a PowerMacintosh (or compatible) !
  53.  
  54.  
  55. How to "Play"...
  56.  
  57. Before creating a new net you can use the Parameters dialog to
  58. set some attributes. You can specify the desired quantity of connections
  59. starting from every neuron. You can also set the average horizontal and
  60. vertical length for the connections, as well as the allowed deviation from
  61. these average values. (If you set the deviation values to 0, all of the
  62. connections will have a uniform length and direction.) Note that both the
  63. average vertical and horizontal length can have negative values (to the
  64. left and down...), but deviation values are always non-negative. Finally,
  65. you can set the net size with the slider (min.: 2x2; max.: 14x14).
  66.  
  67. To create a new net use the "New" command (brilliant, eh?).
  68. The number in each neuron is it's current state. The colors also have
  69. a specific meaning (this is why you really should have a color screen
  70. to use this toy). Red means that the neuron is in its border state and
  71. will light up from the next incoming impulse (Note that neurons with
  72. no outgoing connections are red right from the beginning.) Green means
  73. that that the neuron is in "0-state" (and below its border state...).
  74. Neurons which are between 0-state and their border state are drawn
  75. in blue color. When a neuron lights up, it's drawn with yellow.
  76.  
  77. There are two things you can do to the neurons. Firstly, the neurons
  78. on the left side (in the 1st column) are so called receptors. You can
  79. force any receptor to light up by simply clicking it with the mouse.
  80. Secondly, you can check the "outgoing" connections of any neuron.
  81. With normal neurons (not receptors) this is done by clicking with the
  82. mouse. With receptors you also need to hold down the option-key
  83. in order to not to light the receptor up. In both cases the connections
  84. are shown as long as the mouse button is held down.
  85.  
  86. Finally, if you're too lazy to click them receptors yourself, you can
  87. switch NeuroSim to demo mode with the "Start Demo" command.
  88. Finding out the way to return back to "manual drive" is left as an
  89. exercise to the reader...
  90.  
  91.  
  92. Known Weaknesses
  93.  
  94. I wrote NeuroSim in 9 days in January '96 for a programming class at
  95. the University of Tampere. The essential weakness of the application
  96. must be its lack of a real purpose... As a simulator it is "toyish" at best
  97. and if it were supposed to be a game it should have a goal of some sort.
  98.  
  99. NeuroSim will probably be most useful to other programmers, since I
  100. intend to make all of the source code freely available.
  101.  
  102.         
  103. Version History
  104.  
  105. 1.0         19 Feb 1996
  106.               •    Initial public release.
  107.  
  108.  
  109. Credits & Acknowledgments
  110.  
  111.   •  First of all, my thanks to Leena Heino and Mika Niemelä, who 
  112.       helped me to design NeuroSim.
  113.  
  114.   •  Secondly, I'd like to thank Leo Breebaart for testing and his
  115.       encouraging comments.
  116.       
  117.   •  Special thanks to Scott Squires (squires@crl.com) whose Slider
  118.       package NeuroSim uses for the slider in the Parameters dialog.
  119.       Slider is available from the PowerPlant Contributed Class
  120.       Archive at ftp://atlantis.metrowerks.com/pub/powerplant/.
  121.  
  122.   •  NeuroSim was created using CodeWarrior 8 (by Metrowerks) and 
  123.       ResEdit 2.1.3 (by Apple). I highly recommend the PowerPlant 
  124.       framework which is part of the CodeWarrior package.  
  125.  
  126.   •  Folder icon was made with Folder Icon Maker 1.5 by Greg Robbins.
  127.   
  128.   
  129. Distribution  
  130.  
  131. NeuroSim is freeware, which means that you can use the program for free
  132. but that I still retain the copyright. More specifically, this program cannot
  133. be sold for a profit or distributed thru a commercial channel 
  134. without my written consent. Distribution via online services, BBS's,
  135. Internet, person-to-person and other non-commercial means is acceptable
  136. provided that all original and unaltered files are included in the package. 
  137.  
  138.  
  139. Fine Print
  140.  
  141. [  Here comes the more or less obligatory boring stuff...  ]
  142.  
  143. NeuroSim is supplied "as is". The author makes no warranties, either express
  144. or implied, and will not be liable for any special, incidental, consequential
  145. or indirect damages, including but not limited to loss of data or psychological
  146. damage. The person using this software bears all risk as to its quality and
  147. performance. By using this software, you are subject and agree to the terms
  148. in this disclaimer. In short, use NeuroSim at your own risk.
  149.  
  150.  
  151. Need a Mac Developer?
  152.  
  153. [  I've read a great many ReadMe files in my life, but never have I seen
  154.    anything like what you're about to witness in this section. I guess this
  155.    shows above average ingenuity — or exceptionally poor taste... Before 
  156.    I go any further, I'd like to say that modesty is a fine characteristic in
  157.    a person, but it's nothing but a handicap when you're trying to get hired!
  158.    So, you're now entering the "modesty-free" zone... ]
  159.  
  160. I'm writing this in February 1996. I'm looking forward to graduating from
  161. the University of Tampere in March or April 1996. After that I'd be ready
  162. to get a full time job. Even as the unemployment situation is pretty bad here
  163. in Finland, I'm not really worried about getting hired. To be honest with you,
  164. I've already been offered a developer position in a local software company.
  165. But this company does not develop for the Macintosh and I'd really, really,
  166. REALLY want to become a professional Mac developer!
  167.  
  168. So, now that I have this opportunity, I'm offering myself to any software
  169. company in the world that could use my skills and motivation (in my beloved
  170. homeland there aren't too many companies developing for the Mac, so I'd
  171. certainly consider moving anywhere in the world).
  172.  
  173. I'm afraid I'm NOT an experienced Mac programmer — not yet anyway. NeuroSim
  174. is my third "real" Mac program and only the second one to be released publicly. 
  175. But I've got other assets to make up for my lack of experience. My main asset 
  176. must be my ability to learn things — in other words, I'm quite a bit brighter
  177. than your average Joe (or Jill) Mac... I graduated from high school as the best
  178. of my school (in 1989) with a perfect 10.0 grade average (the scale in Finland
  179. is from 4 to 10). During my university studies I've tried to relax a bit more, but
  180. I've still kept well above average with my grades. I'm majoring in computer
  181. science (surprise, surprise...) but I've also studied mathematics and statistics.
  182. I speak Finnish, English, German, Swedish (only if I get paid for doing so...) and
  183. also understand some Spanish. C++ must be my strongest programming
  184. language, but I'm also familiar with Modula-2, E, Pascal, Smalltalk, Oberon-2,
  185. Eiffel and Prolog (more or less in a descending order of experience).
  186.  
  187. Okay, my modest nature won't let me go any further. You can read more about
  188. me and my interests from my WWW home page (the URL is at the top of this
  189. document). If you're interested in hiring me, please get in touch.
  190.  
  191.  
  192. Contacting the Author
  193.  
  194. For questions, praise, bug reports (oh no!), comments and job offers, I can be
  195. reached via Internet e-mail at
  196.  
  197.   sttiel@uta.fi  (should be valid at least through August 1996)
  198.  
  199. or by "snail mail" (postcards would be greatly appreciated!) at
  200.  
  201.   Timo Eloranta
  202.   Väinämöisenkatu 11 D 347
  203.   FIN-33540 Tampere
  204.   Finland (Europe)
  205.  
  206. _______________________________________________________________
  207.